KFbxThumbnail Class Reference

#include <kfbxthumbnail.h>

Inheritance diagram for KFbxThumbnail:

[legend]

List of all members.

---

Detailed Description

Simple class to hold RGBA values of a thumbnail image.

Definition at line 53 of file kfbxthumbnail.h.

Thumbnail properties
enum	EDataFormat {    eRGB_24,    eRGBA_32 }
	Data format. More...
enum	EImageSize {    eNOT_SET = 0,    e64x64 = 64,    e128x128 = 128,    eCUSTOM_SIZE = -1 }
	Image size. More...
KFbxTypedProperty< fbxInteger1 >	CustomHeight
	Pixel height of the thumbnail image.
KFbxTypedProperty< fbxInteger1 >	CustomWidth
	Pixel width of the thumbnail image.
void	SetDataFormat (EDataFormat pDataFormat)
	Set the data format.
EDataFormat	GetDataFormat () const
	Get the data format.
void	SetSize (EImageSize pImageSize)
	Set the thumbnail dimensions.
EImageSize	GetSize () const
	Get the thumbnail dimensions.
unsigned long	GetSizeInBytes () const
	Get the thumbnail dimensions in bytes.
Thumbnail data access
bool	SetThumbnailImage (const kUByte *pImage)
	Fill the thumbnail image.
kUByte *	GetThumbnailImage () const
	Get the thumbnail image.

---

Member Enumeration Documentation

enum EDataFormat

Data format.

• eRGB_24
• eRGBA_32

Enumerator:

eRGB_24
eRGBA_32

Definition at line 74 of file kfbxthumbnail.h.

enum EImageSize

Image size.

• eNOT_SET
• e64x64
• e128x128
• eCUSTOM_SIZE

Enumerator:

eNOT_SET
e64x64
e128x128
eCUSTOM_SIZE

Definition at line 97 of file kfbxthumbnail.h.

---

Member Function Documentation

void SetDataFormat

(

EDataFormat

pDataFormat

)

Set the data format.

Parameters:

pDataFormat

Data format identifier.

EDataFormat GetDataFormat

(

)

const

Get the data format.

Returns:

Data format identifier for the thumbnail.

void SetSize

(

EImageSize

pImageSize

)

Set the thumbnail dimensions.

Parameters:

pImageSize

Image size identifier.

EImageSize GetSize

(

)

const

Get the thumbnail dimensions.

Returns:

Image size identifier.

unsigned long GetSizeInBytes

(

)

const

Get the thumbnail dimensions in bytes.

Returns:

Thumbnail size in bytes.

bool SetThumbnailImage

(

const kUByte *

pImage

)

Fill the thumbnail image.

Parameters:

pImage

Pointer to the image data. A copy of the image data will be made.

Remarks:

This pointer must point to a buffer region that is at least Width * Height * Component count bytes long. This pointer points to the upper left corner of the image.

You must set the data format and the dimensions before calling this function. If the image size is set to eCUSTOM_SIZE the CustomHeight and CustomWidth properties must be set before calling this function.

Returns:

true if the thumbnail properties were set before calling this function. false otherwise.

kUByte* GetThumbnailImage

(

)

const

Get the thumbnail image.

Returns:

Pointer to the image data, or NULL if the thumbnail is empty.

---

Member Data Documentation

KFbxTypedProperty<fbxInteger1> CustomHeight

Pixel height of the thumbnail image.

Definition at line 65 of file kfbxthumbnail.h.

KFbxTypedProperty<fbxInteger1> CustomWidth

Pixel width of the thumbnail image.

Definition at line 68 of file kfbxthumbnail.h.